home *** CD-ROM | disk | FTP | other *** search
/ The Original Shareware 1.1 / The Original Shareware (WeMake CDs)(Volume 1.1)(CDs, Inc)(1993).iso / 1 / pam419.zip / PAM.DOC next >
Text File  |  1989-06-03  |  15KB  |  306 lines
  1.       PAM (Program Access Menus) Version 4.19
  2.  
  3.       Version 4.10
  4.         Initial public release, given to the public domain by
  5.         Dave Kuntzsch, Burnsville, Mn. 55337
  6.       Version 4.10a
  7.         No code change. Documentation changed to reflect PATH
  8.         statement requirement.
  9.       Version 4.11
  10.         1) Start parameter "BW" has been added to allow displaying
  11.            the menu bar and DOS command line as black on white.
  12.         2) Start Parameter "SN" has been added to eliminate snow
  13.            on CGA monitors.
  14.         3) CD or CHDIR commands from the DOS command line will switch
  15.            directories and immediately display the menu associated
  16.            with the new directory and include it as one of the five
  17.            rolling directory levels.
  18.         4) Help text can be specified for individual menu entries.
  19.         5) Prompt substitution for a menu entry consisting of
  20.            only a CD %1 is added.
  21.         6) Five depressions of F3 (Previous menu) will not return
  22.            to the root directory anymore. Instead you will be
  23.            left positioned at the first of the five rolling levels.
  24.         7) Menu flicker is eliminated when trying to position past
  25.            the top or bottom of the menu.
  26.         8) Documentation Changes: The restriction of 128 lines per
  27.            menu has been clarified. Added a restriction about
  28.            running PAM in multiple DOS windows.
  29.       Version 4.12
  30.         1) A temporary menu is automatically built if one does not
  31.            exist when a directory is entered via a CD command from
  32.            the menu or command line. This eliminates the need to create
  33.            menus and allows executing .COM, .EXE, or .BAT files in
  34.            directories where PAM.MNU does not exist.
  35.         2) Insert mode has been fixed. It would write beyond the
  36.            end of the line.
  37.         3) CHDIR bug fixed (max pathname length was 12).
  38.         4) CD\PATHNAME now allowed (no space is required).
  39.         5) REM commands follow DOS rules and echo if ECHO is ON.
  40.            They are now included in the 128 lines per menu restriction.
  41.       Version 4.13
  42.         1) Two problems with automatic menuing have been fixed. One
  43.            caused a garbage line to be displayed. The other dropped
  44.            a menu item in some cases.
  45.         2) Screen colors are changed.
  46.         3) Item help text has been moved to the top of the menu. The
  47.            "Parms:" prompt has been simplified to " >".
  48.         4) Path statement is no longer required for Dos Ver 3.0 and above.
  49.            It is still required for previous Dos releases.
  50.       Version 4.14
  51.         1) Mouse support added for all operations, including function
  52.            keys and cursor movement. "IM" (ignore mouse) has been added
  53.            as an optional start parameter.
  54.         2) If a valid drive is not entered when started, PAM now puts
  55.            its Bat file in the root directory of the drive specified
  56.            in the COMPSEC environment variable.
  57.         3) Cosmetic changes to the screen. Pam version logo is only
  58.            displayed while in "Help".
  59.         4) Fast path drive change has been added from the command line.
  60.            "Press any key to continue" will not be displayed if only
  61.            a drive specification is entered (ie. "b:").
  62.         5) The "add line" function in Menu Alter now positions the cursor
  63.            at the beginning of the new line.
  64.         6) Six rolling directory levels are now maintained. The number
  65.            of recallable Dos commands has been increased from 5 to 8.
  66.         7) Up arrow will wrap to the bottom of the screen if the bar
  67.            is at the top and on the first menu item. Down arrow will
  68.            wrap to the top of the screen if the bar is on the last
  69.            menu item.
  70.       Version 4.15, 4.16, 4.17 (never released)
  71.       Version 4.18
  72.         1) Current drive is now displayed and can be selected by mouse
  73.            or the Alt key plus drive letter.
  74.         2) Fixed rolling directories to work as documented.
  75.         3) Added error detection in change drive and directory logic.
  76.         4) Bypass PAMCMDS.BAT from auto menus. It would cause a loop if
  77.            inadvertently executed.
  78.         5) Documentation cleaned up.
  79.       Version 4.19
  80.         1) When in Dos command mode, Cursor Up, Cursor Down, PgUp, PgDn
  81.            will switch immediately to Menu mode and and move the Item
  82.            Select Bar.
  83.         2) When in Dos command mode, Pg and Pg are displayed so the
  84.            the mouse can click on them.
  85.  
  86.       DESCRIPTION:
  87.         PAM is a small, easy to use menu system which runs with
  88.       DOS 2.0 through DOS 4.01 and the DOS compatibility box of OS/2 1.1.
  89.       It uses ordinary DOS commands as its language, prefaced by a few
  90.       simple directives which delineate menu entries. A built in editor
  91.       is included to build the menus, but for complex editing, your
  92.       favorite full screen editor can be used. Existing BAT files can
  93.       easily be converted to menu items by copying them to filename
  94.       PAM.MNU which exists in every directory for which you want a menu.
  95.  
  96.       RUNNING PAM:
  97.         Pam is executed by typing "PAM [drive letter] [BW] [SN] [IM]".
  98.       The drive specification is used to determine the root directory
  99.       of the drive to place a bat file on. It can be entered with
  100.       or without a ':'. If drive is not specified or invalid, the
  101.       root directory of the COMSPEC environment variable is used.
  102.       For speed, a VDISK or ramdisk is recommended.
  103.         If BW is specified, the menu bar and DOS command line will
  104.       be displayed as black on white. This is helpful if you are using
  105.       a monochrome monitor with VGA or MCGA since the blue background
  106.       is very dim.
  107.         If SN is specified, BIOS routines are used to write the screen.
  108.       If you are experiencing snow on a CGA monitor, use this option,
  109.       but screen writes will be a bit slower.
  110.         IM can be used if you have a mouse but do not want to use Pam's
  111.       mouse support.
  112.         If BW, IM or SN are included as start parameters, they must be
  113.       after the drive specification. They can be the only parameters and
  114.       the order is not significant.
  115.  
  116.       Examples of valid invocations:
  117.         pam bw
  118.         pam d: bw
  119.         pam c sn
  120.         pam sn bw
  121.         pam e im bw sn
  122.  
  123.       DOS VERSION 2 CONSIDERATION:
  124.       A PATH statement MUST be included in your AUTOEXEC.BAT which
  125.       includes the root directory of the drive to which the
  126.       PAMCMDS.BAT file will be written! An example of commands
  127.       to include in AUTOEXEC.BAT assuming you have a VDISK of D:
  128.       would be:
  129.         path d:\;c:\;c:\batfiles
  130.         rem the following statements allow the shell process
  131.         rem to run faster since command.com will not have
  132.         rem to be loaded from disk.
  133.         copy command.com d: > nul
  134.         if exist d:command.com set comspec=d:\command.com
  135.         pam d
  136.  
  137.       NOTE! THE PATH STATEMENT IS REQUIRED EVEN IF DRIVE SPEC IS
  138.             NOT SPECIFIED FOR DOS VERSION 2. IT IS NOT REQUIRED
  139.             FOR DOS VERSION 3 AND GREATER.
  140.  
  141.       TEMPORARY MENU SUPPORT:
  142.       Each time the current directory is changed PAM will search
  143.       the directory for a file named PAM.MNU, and will display its
  144.       menu entries if found. If not, a temporary menu is built and
  145.       displayed containing CHDIR commands to the parent and all
  146.       subdirectories. Also all .COM, .EXE, and .BAT files are included
  147.       and can be executed via menu selection. This temporary menu is
  148.       not written unless you enter Alter Menu (F4) and save it. It can
  149.       be tailored as desired before saving.
  150.  
  151.       MOUSE SUPPORT:
  152.       A mouse following the Microsoft (TM) standard is supported. Proper
  153.       drivers must be preloaded before Pam is started. Only 2 buttons are
  154.       recognized and there is no distinction between them. To run a program
  155.       from a menu, position the mouse anywhere within the box on the same
  156.       line as the item. Click once and the menu bar will move to that
  157.       line and any optional help text will appear. A second click will run
  158.       the program. If the bar was already on the line, the first click
  159.       will run the program. You can click on a menu item directly, even
  160.       if you are in Dos Command Mode.
  161.         Pg, Pg, [Y], [N] and function keys can also be clicked.
  162.       "Press any key to continue" when displayed on the help screen
  163.       can also be replied to with a button press.
  164.  
  165.       FUNCTION KEYS:
  166.       F1 - Help screen for using PAM.
  167.       F2 - Toggle between MENU mode and DOS command mode. In MENU
  168.            mode, entries are selected using the cursor keys and
  169.            Press Enter to run when the desired entry is highlighted.
  170.            In COMMAND mode, any DOS command can be entered and
  171.            executed as if from the native DOS prompt.
  172.       F3 - Backup in menu structure. This function follows single
  173.            CHDIR or CD commands in the menu files, or the same
  174.            commands from the DOS command line. It does not necessarily
  175.            follow your DOS directory hierarchy. If you traverse more
  176.            than six directories without backing up, the six most
  177.            current paths are retained.
  178.       F4 - Alter or create the current menu in the current
  179.            directory using the built in editor. All editor
  180.            functions are documented by the function keys displayed
  181.            on the screen, or by the editor help screen.
  182.       F5 - Recall one of eight previous DOS commands for modification
  183.            and/or execution. Each successive depression will
  184.            recall another command from the eight. This list will
  185.            continually wrap as more commands are entered.
  186.       F10 - Return to the root directory menu.
  187.       Alt-F10 - Exit the PAM system permanently. It can be
  188.            reentered as described above.
  189.       Alt-a thru Alt-z - Switch to the drive specified by the alpha
  190.            character (a - z).
  191.       Esc - Same function as F3.
  192.  
  193.       CREATING MENUS:
  194.         Menus are nothing more than ordinary DOS commands necessary
  195.       to execute whatever function or program you desire. There
  196.       are four special character sequences which direct PAM.
  197.  
  198.       MENU TITLE
  199.         Any line preceded by /$ becomes the title of the menu. It
  200.       can be placed anywhere within the menu. If more than one
  201.       is encountered, the last one is used as the title.
  202.         /$THIS IS A MENU TITLE
  203.  
  204.       MENU ITEM
  205.         Any line preceded by /* is a menu item title. This line
  206.       will generally be followed by the DOS commands to run what
  207.       the item describes.
  208.         /*LIST DIRECTORY and RUN CHKDSK
  209.         dir
  210.         pause
  211.         chkdsk
  212.  
  213.       HELP TEXT
  214.         A line preceded by /# will be displayed as help text when
  215.       its associated menu entry is highlighted. The "/#Help text"
  216.       can be placed anywhere within the command stream for a menu
  217.       entry and is used to display more information about the
  218.       entry such as what kind of response is appropriate for the
  219.       " >" prompt. If multiple /# lines are encountered in an entry,
  220.       only the last one will be displayed.
  221.         /*MOVE FILES FROM TEST DIRECTORY
  222.         /#This moves files from test to production
  223.         copy \test\*.* \prod\*.*
  224.         del \test\*.*
  225.  
  226.       ENTERING OPTIONAL PROGRAM PARAMETERS
  227.         Any time %1 appears in any line of DOS menu commands, a
  228.       "  >" prompt will be presented for that highlighted menu
  229.       item. Anything entered in response to the prompt will be
  230.       substituted for the %1. (%2 though %9 are not supported as
  231.       in normal DOS bat files.) As long as unique parameters do
  232.       not have to be passed on separate lines, the same effect can
  233.       be achieved by entering multiple parameters and all will
  234.       be substituted for %1:
  235.         MYPROG %1 %2 %3 could be changed to MYPROG %1 and
  236.         MYPROG parm1 parm2 parm3 will be substituted for %1.
  237.  
  238.       SAMPLE MENU
  239.         /$THIS IS A SAMPLE MENU
  240.         /*LIST SPECIFIED DIRECTORY
  241.           rem Lines are indented for readability only,
  242.           rem since spaces are ignored.
  243.           rem The following statement allows the user to
  244.           rem enter a pathname in response to a prompt and
  245.           rem then execute the Dos DIR command.
  246.         /#Enter the pathname of the directory
  247.           dir %1
  248.           pause
  249.         /*CHANGE TO UTILITIES MENU
  250.           rem The following command changes the
  251.           rem current directory. PAM will automatically
  252.           rem read and display any menu in that directory.
  253.           rem The menu filename will always be 'Pam.Mnu'
  254.           CD \util
  255.         /*RUN MYPROG IF NEWFILE EXISTS
  256.           if not exist newfile goto MSG
  257.           MYPROG parm1
  258.           goto END
  259.          :MSG
  260.           echo Program not run!!!
  261.          :END
  262.  
  263.       RESTRICTIONS:
  264.       1) DOS RELEASES PRIOR TO 3.0 MUST HAVE A PATH STATEMENT
  265.          WHICH INCLUDES THE ROOT DIRECTORY OF THE DRIVE ON
  266.          WHICH PAMCMDS.BAT IS PLACED. Read RUNNING PAM and DOS
  267.          VERSION 2 CONSIDERATIONS for more detailed information.
  268.       2) Menu lines are restricted to 50 characters and will be
  269.          truncated if exceeded.
  270.       3) Each menu can have a maximum of 64 item titles. Menus
  271.          exceeding 64 items will be truncated
  272.       4) Each menu can have a maximum of 128 lines including
  273.          titles, help lines and commands. Menus exceeding 128
  274.          lines will be truncated.
  275.       5) Directory pathname length is restricted to 40 characters.
  276.          The rolling directory function will be unpredictable
  277.          if you enter a directory with a pathname of greater than
  278.          40 characters.
  279.       6) If you are running something which allows multiple DOS's
  280.          or windows, the PAM running in each window must specify
  281.          a different drive ID. If not, several copies will share
  282.          the same PAMCMDS.BAT file and results will be unpredictable.
  283.  
  284.          Here is a bat file which allows PAM to run in 2 DOS windows
  285.          using DOS 3.3 and IBM's Work Station Program (TM). It might be
  286.          applicable to other environments.
  287.  
  288.          rem The following code sets up unique directories on a VDISK
  289.          rem to allow two copies of PAM to run. It uses the environment
  290.          rem to save the drive ID to use for Pamcmds.Bat. The VDISK is D:
  291.          if exist d:\pamcmds.bat goto :DIR1
  292.          set pam=d:
  293.          goto :RUN
  294.         :DIR1
  295.          rem create a new directory and call it drive E:
  296.          md d:\pam1 > nul
  297.          subst e: d:\pam1 > nul
  298.          set pam=e:
  299.         :RUN
  300.          rem The next statements create a dummy file in a VDISK directory.
  301.          rem It also copies Command.Com to the VDISK.
  302.          copy command.com d:\ > %pam%\pamcmds.bat
  303.          if exist d:\command.com set comspec=d:\command.com
  304.          rem invoke PAM using parameters set in the environment
  305.          pam %pam% bw
  306.